Bug 1506176 - manage_services tag needs better documentation in help
Summary: manage_services tag needs better documentation in help
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: ovirt-engine-metrics
Classification: oVirt
Component: Generic
Version: 1.0.7.1
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ovirt-4.2.2
: ---
Assignee: Shirly Radco
QA Contact: Lukas Svaty
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-10-25 10:30 UTC by Lukas Svaty
Modified: 2018-03-29 11:04 UTC (History)
3 users (show)

Fixed In Version: ovirt-engine-metrics-1.1.3.3
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-03-29 11:04:53 UTC
oVirt Team: Metrics
Embargoed:
rule-engine: ovirt-4.2+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
oVirt gerrit 85415 0 None None None 2018-01-04 13:08:33 UTC
oVirt gerrit 88596 0 master MERGED Update manage-services readme 2018-03-07 13:27:04 UTC

Description Lukas Svaty 2017-10-25 10:30:10 UTC
Description of problem:
Based on BZ#1468895 we need to add better help for manage_services tag in configuration playbook, and list available options.

Comment 2 Yaniv Kaul 2018-02-22 13:37:19 UTC
Shirly, any reason it's not ON_QA?

Comment 3 Lukas Svaty 2018-03-07 11:31:19 UTC
Issues reported in /usr/share/ansible/roles/oVirt.metrics/roles/oVirt.manage-services/README.md:

Line 3: missing comma in the end of the line
fixed
Line 5: this blank line should not be included
not fixed
Line 12-14: 3 empty lines, I believe it should be just 2
fixed
Line 16-17: 2 empty lines, I believe it should be just 1
fixed
Line 20: missing comma in the end of the line
not fixed
Line 31: s/these variable/these variables
not fixed
Line 32: missing comma in the end of the line
fixed
Line 35: s/Ovirt/oVirt/
not fixed
Line 49: s/need a configuration file/need to update the configuration file/
fixed

Help looks good:
root@ ~]# /usr/share/ovirt-engine-metrics/setup/ansible/configure_ovirt_machines_for_metrics.sh --tags=manage_services --help
Usage: /usr/share/ovirt-engine-metrics/setup/ansible/configure_ovirt_machines_for_metrics.sh

  --playbook=PLAYBOOK
        PLAYBOOK, the name of the playbook to run, is one of:
        configure-ovirt-metrics.yml, manage-ovirt-metrics-services.yml, ovirt-metrics-store-installation.yml.
        Default is configure-ovirt-metrics.yml.
  --scope=SCOPE
        SCOPE is one of 'hosts', 'engine', 'all'.
        Default is 'all'.
  --log=FILE
        Write the log also to FILE.
        Default is to a file inside /var/log/ovirt-engine/ansible.

  Available params for manage-ovirt-metrics-services.yml playbook:
  -e service_state=SERVICE_STATE
        SERVICE_STATE is one of 'started', 'restarted', 'stopped', 'reloaded'.
        Default is 'restarted'.
  -e service_name=SERVICE_NAME
        SERVICE_NAME is a list of the services that will be managed by the role.
        Default is ["collectd", "fluentd"].
  -e service_enabled=SERVICE_ENABLED
        SERVICE_ENABLED is used to configure if the processes will be enabled.
        Default is 'yes'.

  Other ansible playbook parameters are passed to the ansible-playbook.

Tested in:
ovirt-engine-metrics-1.1.3.2-1.el7ev.noarch

FailedQA due to unsolved issues in README.

Comment 4 Red Hat Bugzilla Rules Engine 2018-03-07 11:31:22 UTC
Target release should be placed once a package build is known to fix a issue. Since this bug is not modified, the target version has been reset. Please use target milestone to plan a fix for a oVirt release.

Comment 5 Lukas Svaty 2018-03-20 11:58:19 UTC
verified in ovirt-engine-metrics-1.1.3.3-1.el7ev.noarch

Comment 6 Sandro Bonazzola 2018-03-29 11:04:53 UTC
This bugzilla is included in oVirt 4.2.2 release, published on March 28th 2018.

Since the problem described in this bug report should be
resolved in oVirt 4.2.2 release, it has been closed with a resolution of CURRENT RELEASE.

If the solution does not work for you, please open a new bug report.


Note You need to log in before you can comment on or make changes to this bug.