Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1531115

Summary: [Docs][RFE][Metrics Install] Remove Appendix with Inventory file and Vars Files
Product: Red Hat Enterprise Virtualization Manager Reporter: Emma Heftman <eheftman>
Component: DocumentationAssignee: Emma Heftman <eheftman>
Status: CLOSED CURRENTRELEASE QA Contact: Avital Pinnick <apinnick>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 4.2.0CC: lsurette, rbalakri, sradco, srevivo, ykaul
Target Milestone: ---Keywords: FutureFeature, Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: docs-accepted
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-02-18 08:36:05 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: 1542973    
Bug Blocks:    

Description Emma Heftman 2018-01-04 15:41:57 UTC
For Beta 1 I created 2 appendixes as a temporary solution until the files themselves were added to the correct repo.

Once they are in the correct place, need to remove the appendix and update the docs to say which repo to retrieve them from, rather than copying them from the appendix.

Comment 1 Emma Heftman 2018-02-08 14:16:33 UTC
(In reply to Emma Heftman from comment #0)
> For Beta 1 I created 2 appendixes as a temporary solution until the files
> themselves were added to the correct repo.
> 
> Once they are in the correct place, need to remove the appendix and update
> the docs to say which repo to retrieve them from, rather than copying them
> from the appendix.

In addition, remove from 1.10. CUSTOMIZING VARS.YAML the documentation about configuring namespaces.

Comment 2 Emma Heftman 2018-02-13 12:07:03 UTC
Hi Shirly
Please let me know whether I can now remove these files from the appendix as well as the exact instructions for accessing these files.

Comment 3 Emma Heftman 2018-02-15 11:41:20 UTC
There are also additional parameters that must be documented as part of this change:

From doc-text>
Additional parameters that user needs to update in the config.yml:
viaq_metrics_store: (required - Default: true)

Use ViaQ Logging metrics store

openshift_deployment_type: (required - no default value)

Reguired if viaq_metrics_store is true. This repository supports OpenShift Origin and OpenShift Container Platform. If you want to install ViaQ Logging you should choose the deployment type. Available options: origin, openshift-enterprise.

For downstream must user openshift-enterprise

Comment 4 Emma Heftman 2018-02-15 12:30:04 UTC
Hi Shirly

In the following section (configuring ansible prerequisites) we enabled the user to define a non-root user which required editing the vars.yaml file.

As we now no longer have the need to edit this file, should we still allow them to create a non-root user?
---
. Use the root user or create a user account. This user will be referred to below as $USER. If you do not use the root user, you must update _ansible_ssh_user_  and _ansible_become in vars.yaml_. See xref:Customizing_vars_yaml[Customizing vars.yaml].
----

Comment 5 Emma Heftman 2018-02-15 13:10:59 UTC
(In reply to Emma Heftman from comment #4)
> Hi Shirly
> 
> In the following section (configuring ansible prerequisites) we enabled the
> user to define a non-root user which required editing the vars.yaml file.
> 
> As we now no longer have the need to edit this file, should we still allow
> them to create a non-root user?
> ---
> . Use the root user or create a user account. This user will be referred to
> below as $USER. If you do not use the root user, you must update
> _ansible_ssh_user_  and _ansible_become in vars.yaml_. See
> xref:Customizing_vars_yaml[Customizing vars.yaml].
> ----

As discussed, i left this in and added where they can find the file.

Comment 7 Shirly Radco 2018-02-15 14:48:52 UTC
looks ok to me.