Bug 1366186

Summary: [doc] issues with description of firewall configuration
Product: [Red Hat Storage] Red Hat Storage Console Reporter: Martin Bukatovic <mbukatov>
Component: documentationAssignee: Rakesh <rghatvis>
Status: CLOSED CURRENTRELEASE QA Contact: Martin Kudlej <mkudlej>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 2CC: mkudlej, nthomas, sankarshan
Target Milestone: ---   
Target Release: 2   
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: 2018-11-19 05:32:35 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 Martin Bukatovic 2016-08-11 09:15:48 UTC
Document URL
============

Red Hat Storage Console 2.0 Quick Start Guide

https://access.qa.redhat.com/documentation/en/red-hat-storage-console/2.0/single/red-hat-storage-console-20-quick-start-guide

Section Number and Name
=======================

section "2.4. Firewall Configuration"

https://access.qa.redhat.com/documentation/en/red-hat-storage-console/2.0/single/red-hat-storage-console-20-quick-start-guide#firewall_configuration

Describe the issue
==================

I see the following problems with the firewall setup documentation:

* it uses `sudo` while all the other examples just starts with `# ` to make
  clear that one needs to run this under root account (needles inconsistency)
* there also seems to be a typographic difference between boxes with firewall-cmd
  commands and other commands in the guide (gray vs black boxes)
* firewall-cmd commands doesn't make the rules permanent, which means that
  the configuration would not survive a reboot
* firewall setup for ceph-installer is done via ceph-installer firewalld
  service file - but the doc doesn't state that for this to work, one needs
  to have this package already installed (obviously, though)
* documentation doesn't mention at which point should one setup the firewall
  (doing this as a very 1st thing would fail because of the previous point)

Suggestions for improvement
===========================

* `sudo` should be dropped and the design (typogrhaphy) of the boxes with
  firewall-cmd commands should be aligned with the rest of the guide
* describe how to configure firewall in a permanant way
* note that for `firewall-cmd --zone=public --add-service=ceph-installer` to
  work, one needs to have ceph-installer package installed
* suggest when to perform firewall configuration

Comment 2 Martin Kudlej 2016-08-16 14:05:06 UTC
It seems OK to me.