Bug 1754244

Summary:	[Docs][Metrics] Information how to enable verbose mode for scripts
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Shirly Radco <sradco>
Component:	Documentation	Assignee:	Eli Marcus <emarcus>
Status:	CLOSED CURRENTRELEASE	QA Contact:	rhev-docs <rhev-docs>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	4.3.5	CC:	emarcus, lsurette, lsvaty, mkalinin, obockows, pelauter, srevivo, tburke
Target Milestone:	ovirt-4.3.8	Keywords:	Documentation, NoDocsQEReview, Task, ZStream
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:	1753941	Environment:
Last Closed:	2019-12-19 14:47:35 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Metrics	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1753941
Bug Blocks:	902971

Description Shirly Radco 2019-09-22 07:31:09 UTC

+++ This bug was initially created as a clone of Bug #1753941 +++

Description of problem:
In "Metrics Store Installation Guide" there is no info on how to debug problems.

In both sections:
2.1. Create the Metrics Store virtual machines / Create Metrics Store virtual machines / Point 2 (Run the ovirt-metrics-store-installation playbook to create the virtual machines)

2.2. Deploy Metrics Store services on Red Hat OpenShift / Procedure / Point 2 

There should be info (as NOTE for example), how to enable more verbose output in: ovirt-engine-metrics version 1.3.3.3
 
so the command should be prefixed with either:
ANSIBLE_VERBOSITY=X , where is is 2, 3 or 4 

JUSTIFICATION:
We can't assume someone who reads knows Ansible well and even he knows we are running the script what makes it more complicated.

MORE INFO:
when we run 
./configure_ovirt_machines_for_metrics.sh  --help 
there is no info how to enable debug, putting there -vvv doesn't work. Apart from env variable, one could edit script and put "-vv \" in line 123

--- ./configure_ovirt_machines_for_metrics.sh
+++ ./configure_ovirt_machines_for_metrics.v2.sh
@@ -122,0 +123 @@
+	-vv \

--- Additional comment from Shirly Radco on 2019-09-22 07:28:48 UTC ---

Add to the following commands -vvv :

1. ANSIBLE_JINJA2_EXTENSIONS="jinja2.ext.do" ./configure_ovirt_machines_for_metrics.sh --playbook=ovirt-metrics-store-installation.yml --ask-vault-pass

should be 
ANSIBLE_JINJA2_EXTENSIONS="jinja2.ext.do" ./configure_ovirt_machines_for_metrics.sh --playbook=ovirt-metrics-store-installation.yml --ask-vault-pass -vvv

2. ANSIBLE_CONFIG="/usr/share/ansible/openshift-ansible/ansible.cfg" \
  ANSIBLE_ROLES_PATH="/usr/share/ansible/roles/:/usr/share/ansible/openshift-ansible/roles" \
  ansible-playbook -i integ.ini install_okd.yaml -e @vars.yaml -e @secure_vars.yaml --ask-vault-pass

should be

ANSIBLE_CONFIG="/usr/share/ansible/openshift-ansible/ansible.cfg" \
  ANSIBLE_ROLES_PATH="/usr/share/ansible/roles/:/usr/share/ansible/openshift-ansible/roles" \
  ansible-playbook -i integ.ini install_okd.yaml -e @vars.yaml -e @secure_vars.yaml --ask-vault-pass -vvv

or add a comment about the option of adding verbose mode, by adding -vvv to the commands.

-v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)

Comment 1 Eli Marcus 2019-11-24 15:27:39 UTC

Hi Shirly, I added the following note to each procedure: 


NOTE: To enable verbose mode for debugging, add `-vvv` to the end of the command, or add `-vvvv` to enable connection debugging.