Bug 1489880

Summary: Setting up Client Authentication Between Servers and Agents is not documented correctly
Product: [JBoss] JBoss Operations Network Reporter: Prachi <pyadav>
Component: DocumentationAssignee: jon-docs <jon-docs>
Status: CLOSED CURRENTRELEASE QA Contact: Mike Foley <mfoley>
Severity: medium Docs Contact:
Priority: medium    
Version: JON 3.3.9CC: fbrychta, pyadav, tkelly
Target Milestone: post-GAKeywords: Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-12-19 00:25:59 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:

Description Prachi 2017-09-08 14:45:19 UTC
Document URL:

 https://access.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html/admin_and_config/jboss_on_and_ssl-authentication

Section Number and Name: Procedure 4.1. 

Describe the issue: 

1)  Just after Procedure 4.1. their are CLI commands to which set up SSL configuration, and it is not clear if it a different way to setup SSL or first step. It should not be the first step, i have skipped cli part but still my setup worked.

2) their are commands to create keystore and truststore, which creates only one certificate and only certificate is imported. But in verify step result shows 2 entries, and this is confusing for beginner.

3) In step 5: Distribute both the keystore and the truststore files to all the JBoss ON and server and agent machines, the files name are not the same with the one created as per document. which is again confusing.

4) rhq-server.properties and agent configuration section again,  values given to create keystore and truststore are different than defined in server and agent configuration file. for example:  alias is "server1" and while defining in agent configuration it is given "myhost"


Suggestions for improvement: Document should work even if copy paste the command
and configuration. For example, alias should match with keystore alias and configuration file. If we are giving a example in documentation, it should show the same thing... so it is should clear, if alias is changing, it should be changed both the places. It should not create any confusion.

Additional information: 
Documentation should be like, by referring anyone can use the product at-least with default configuration. (just a sugestion)

Comment 1 Tyler Kelly 2017-12-06 07:53:10 UTC
Have the issues you identified been addressed by these changes? If not, what additional changes need to be made?

I was initially confused by this section as well.

Update: some changes made to formatting to improve clarity, attempted to improve consistency of aliases and file names and a few minor edits.

Git Merge:
https://gitlab.cee.redhat.com/red-hat-jboss-operations-network-documentation/doc-jon-docs/merge_requests/100/diffs
Preview:
https://access.qa.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html-single/admin_and_config/#JBoss_ON_and_SSL-Authentication

Comment 2 Tyler Kelly 2017-12-12 03:16:37 UTC
Moving to QA

Comment 4 Tyler Kelly 2017-12-19 00:25:59 UTC
Updated content now live on the customer portal.
Updated section can be found here:
https://access.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html/admin_and_config/jboss_on_and_ssl-authentication

Comment 5 Red Hat Bugzilla 2023-09-14 04:07:38 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days