Bug 1510084 - Need to update HOSA install docs for 3.6
Summary: Need to update HOSA install docs for 3.6
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.6.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 3.9.z
Assignee: Michael Burke
QA Contact: Vikram Goyal
Vikram Goyal
URL:
Whiteboard:
Depends On: 1464871
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-11-06 16:44 UTC by Matt Wringe
Modified: 2021-03-11 16:12 UTC (History)
9 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1464871
Environment:
Last Closed: 2018-05-16 14:54:03 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Comment 1 Matt Wringe 2017-11-06 16:46:35 UTC
The docs for the 3.6 metrics installation (https://access.redhat.com/documentation/en-us/openshift_container_platform/3.6/html/installation_and_configuration/install-config-cluster-metrics#deploying-hawkular-openshift-agent) need to be updated.

The way to install metrics in HOSA has changed in 3.6 and its now handled in the ansible configuration file. The docs for master already contain this change, it just needs to be backported to the 3.6 branch.

Comment 2 Michael Burke 2017-11-16 21:17:02 UTC
I believe this change was made to the 3.6+ docs on sept. 29 through:
https://github.com/openshift/openshift-docs/pull/5419

The `openshift_metrics_install_hawkular_agent` variable is at the bottom of table 2 in:
https://docs.openshift.com/container-platform/3.6/install_config/cluster_metrics.html#metrics-ansible-variables

Please verify that this meets your needs.

Comment 3 Matt Wringe 2017-11-16 22:02:02 UTC
from https://bugzilla.redhat.com/show_bug.cgi?id=1510084#c1 its not in the 3.6 docs, but its already been committed in master.

This issue is to get the changes in the 3.6 docs.

Comment 4 Michael Burke 2017-11-16 22:14:40 UTC
@matt --

Please check this link, that is for 3.6

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.6/html/installation_and_configuration/install-config-cluster-metrics#deploying-hawkular-openshift-agent



openshift_metrics_install_hawkular_agent
	
Set to true to install the Hawkular OpenShift Agent (HOSA). Set to false to remove the HOSA from an installation. HOSA can be used to collect custom metrics from your pods. This component is currently in Technology Preview and is not installed by default.

Comment 5 Matt Wringe 2017-11-16 22:23:42 UTC
(In reply to Michael Burke from comment #4)
> @matt --
> 
> Please check this link, that is for 3.6
> 
> https://access.redhat.com/documentation/en-us/openshift_container_platform/3.
> 6/html/installation_and_configuration/install-config-cluster-
> metrics#deploying-hawkular-openshift-agent
> 
> 
> 
> openshift_metrics_install_hawkular_agent
> 	
> Set to true to install the Hawkular OpenShift Agent (HOSA). Set to false to
> remove the HOSA from an installation. HOSA can be used to collect custom
> metrics from your pods. This component is currently in Technology Preview
> and is not installed by default.

The link you pointed to, the whole 32.7 section is completely wrong and needs to be removed. That is not how we install or deploy HOSA anymore.

Table 32.2 does describe how to install it using ansible, but we still need to remove the 32.7 section.

Comment 6 Michael Burke 2018-03-20 19:55:28 UTC
The "Deploying the Hawkular OpenShift Agent" section is present in 3.6, not 3.7+. So, changing the BZ version to 3.6.0

https://docs.openshift.com/container-platform/3.6/install_config/cluster_metrics.html#deploying-hawkular-openshift-agent"

Comment 7 Michael Burke 2018-03-20 20:10:37 UTC
Matt --

Sorry I took so long to deal with this. 

I removed the "Deploying the Hawkular OpenShift Agent" section from the 3.6 docs. The section was removed from 3.7+ in a separate PR that was not rolled back to 3.6.

See:
https://github.com/openshift/openshift-docs/pull/8281

Michael

Comment 8 Michael Burke 2018-03-20 20:16:07 UTC
PR removing the section from 3.7.

https://github.com/openshift/openshift-docs/pull/5419

Comment 9 Michael Burke 2018-04-13 00:18:36 UTC
Updated PR
https://github.com/openshift/openshift-docs/pull/8726


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