Bug 1723313
| Summary: | foreman_tasks:cleanup description contain inconsistent information | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Steffen Froemer <sfroemer> |
| Component: | Tasks Plugin | Assignee: | Dominik Matoulek <dmatoule> |
| Status: | CLOSED ERRATA | QA Contact: | Peter Ondrejka <pondrejk> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.5.0 | CC: | aruzicka, dmatoule, inecas |
| Target Milestone: | 6.8.0 | Keywords: | EasyFix, Triaged |
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | tfm-rubygem-foreman-tasks-0.17.4 | Doc Type: | If docs needed, set a value |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2020-10-27 12:58:39 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
Created redmine issue https://projects.theforeman.org/issues/28276 from this bug Moving this bug to POST for triage into Satellite 6 since the upstream issue https://projects.theforeman.org/issues/28276 has been resolved. Verified on Sat 6.8 snap 1, the requested changes in the description landed downstream Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (Important: Satellite 6.8 release), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHSA-2020:4366 |
Description of problem: Docs of foreman_tasks:cleanup contain wrong information Version-Release number of selected component (if applicable): tfm-rubygem-foreman-tasks-0.14.4.6-1.el7sat.noarch How reproducible: always Steps to Reproduce: 1. foreman-rake -D foreman_tasks:cleanup Actual results: rake foreman_tasks:cleanup:config Show the current configuration for auto-cleanup rake foreman_tasks:cleanup:run Clean tasks based on filter and age. ENV variables: * TASK_SEARCH : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"') * AFTER : delete tasks created after *AFTER* period. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days * STATES : comma separated list of task states to touch with the cleanup, by default only stopped tasks are covered, special value all can be used to clean the tasks, disregarding their states * NOOP : set to "true" if the task should not actually perform the deletion * VERBOSE : set to "true" for more verbose output * BATCH_SIZE : the size of batches the tasks get processed in (1000 by default) * TASK_BACKUP : set to "true" or "false" to enable/disable task backup If none of TASK_SEARCH, BEFORE, STATES is specified, the tasks will be cleaned based configuration in settings Expected results: There should no reference shown regarding 'BEFORE' statement, as it seems this is deprecated [1]. In addition, there should be an information, that the time-value of 'started_at' will be referenced. Also it's not really clear, how the AFTER keyword is working. What are the time units (s,h,m,y), when directly afterwards we talk about 'd'? If this is just an example list, it should be declared as such (like (e.g. s = seconds, h = hours, d = days, ...) Additional info: [1]: https://projects.theforeman.org/issues/8144