Bug 1229390

Summary: [Docs] Document restrictions on displaying files collected
Product: Red Hat CloudForms Management Engine Reporter: Thom Carlin <tcarlin>
Component: DocumentationAssignee: Shikha <snansi>
Status: CLOSED CURRENTRELEASE QA Contact: Suyog Sainkar <ssainkar>
Severity: medium Docs Contact:
Priority: medium    
Version: 5.4.0CC: adahms, cpelland, jhardy, mfeifer, obarenbo, tcarlin
Target Milestone: GA   
Target Release: 5.4.3   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-11-24 02:06:05 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1277330    

Description Thom Carlin 2015-06-08 15:11:30 UTC
Description of problem:

https://bugzilla.redhat.com/show_bug.cgi?id=1227441 refers to message "Cannot display binary contents".  Please document actual restrictions.

Version-Release number of selected component (if applicable):

5.4.0.5.20150605150206_7daa1a8

Additional info:

Comment 3 Andrew Dahms 2015-06-24 02:20:05 UTC
Assigning to Shikha for review.

Comment 4 Shikha 2015-09-11 00:53:47 UTC
Hi Thom,
I did some research on the file restrictions and found the some information from these git commits:
https://github.com/Ladas/manageiq/commit/fbd0c0e4d9e84bb218de82b4293d1621f2d7f338
https://github.com/Ladas/manageiq/commit/02f9db3517b6ff006168b6d43bf162606c026d81

1) Please confirm if the following list is the file restrictions that needs to be documented. Please also let me know if there are more file restrictions.

Non-displayable file types

- file size bigger than 20k characters is not displayable
- file with missing name is not displayable
- non MIME .conf file, with non ascii characters is not displayable
- non MIME .conf file, without content is not displayable
- MIME .exe binary file is not displayable

Displayable file types:

- MIME .txt non binary file is displayable
- non MIME .conf ascii file is displayable

2) Do these restrictiontos apply to all Providers on CFME or just VMware and OpenStack Providers?

3) From the following links, please confirm which section is the most appropriate for documenting this information:

- https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/3.2/html-single/Insight_Guide/index.html#sect-Analyzing_Virtual_Machines_and_Templates
- https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/3.2/html/Installing_CloudForms_on_Red_Hat_Enterprise_Virtualization/sect-Additional_Requirements.html
- https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/3.2/html/Installing_CloudForms_on_VMware_vSphere/sect-Additional_Requirements.html

Regards,
Shikha

Comment 5 Thom Carlin 2015-09-14 21:00:19 UTC
1) That seems right to me
2) afaik, yes
3) I would defer to the developer

Comment 6 Shikha 2015-10-12 01:49:14 UTC
Hi Thom,
Thank you for the feedback. I have added a note in the Insight guide about the file restrictions. Please review the Note in the following link and provide feedback:
http://10.34.3.139:8080/job/doc-Red_Hat_CloudForms-Insight_Guide-branch-3.2/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Analyzing_Instances_and_Images

Regards,
Shikha

Comment 7 Thom Carlin 2015-10-12 22:17:55 UTC
Those updates look good to me so verified in latest spin.

Side notes:

You *may* want to consider a hyperlink in Section 2.4.6, second sentence: "If CloudForms Management Engine is not set up for automatic analysis (as detailed in to Settings and Operations Guide, Section 3.1 or somewhere in Section 4).

Similar comments for Section 3.6.6 although I didn't see any documented way to setup for automatic analysis.

Comment 8 Andrew Dahms 2015-11-24 02:06:05 UTC
This content is now live on the Customer Portal.

Closing.