Bug 2025290

Summary:	[Docs] Add uid,pwd parameters to Installing collectd and rsyslog docs
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Aviv Litman <alitman>
Component:	Documentation	Assignee:	Eli Marcus <emarcus>
Status:	CLOSED CURRENTRELEASE	QA Contact:	rhev-docs <rhev-docs>
Severity:	medium	Docs Contact:
Priority:	high
Version:	4.5.0	CC:	apinnick, emarcus, lsurette, mhicks, srevivo
Target Milestone:	ovirt-4.5.0-1	Keywords:	Documentation
Target Release:	---	Flags:	emarcus: needinfo-
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	docscope 4.5
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2022-05-30 11:07:09 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Docs	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1990462
Bug Blocks:

Description Aviv Litman 2021-11-21 13:23:37 UTC

Description of problem:

We added 2 new parameters uid and pwd  to ELK integration.
we want to update the Installing collectd and rsyslog docs on how to use them.

Needs to update: https://www.ovirt.org/documentation/administration_guide/index.html#sending-metrics-and-logs-to-a-remote-instance-of-elasticsearch, https://access.redhat.com/articles/4921101. 

Needs to add:
If basic HTTP authentication is deployed, the elasticsearch password needs to be specified and encrypted:

Copy /etc/ovirt-engine-metrics/secure_vars.yaml.example to create /etc/ovirt-engine-metrics/config.yml.d/secure_vars.yaml:
cp /etc/ovirt-engine-metrics/secure_vars.yaml.example /etc/ovirt-engine-metrics/config.yml.d/secure_vars.yaml

Encrypt the file and set the vault password:
ansible-vault encrypt /etc/ovirt-engine-metrics/config.yml.d/secure_vars.yaml 

specifie the logging_elasticsearch_password to the encrypted file, the elasticsearch servers should share one password if there are multiple of servers.
ansible-vault edit /etc/ovirt-engine-metrics/config.yml.d/secure_vars.yaml 
Note: the default user name is “elastic” if you want to use a different one you should add the “uid” parameter in config.yml file.

Deploy collectd and rsyslog on the hosts:
/usr/share/ovirt-engine-metrics/setup/ansible/configure_ovirt_machines_for_metrics.sh --ask-vault-pass

Comment 1 Eli Marcus 2022-05-19 14:40:05 UTC

Hi Aviv, 
here is the draft of the updates: 

https://access.redhat.com/node/4921101/draft

- I don't see a definition for the new parameters uid and pw 
 
- do these parameters need to be added to the list of logging parameters in section 4.1.2 ?
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide/index#Logging_schema

Comment 2 Aviv Litman 2022-05-24 08:49:23 UTC

LGTM! 

There is no need to add these parameters to the list in section 4.1.2.