Bug 1366186 - [doc] issues with description of firewall configuration
Summary: [doc] issues with description of firewall configuration
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Storage Console
Classification: Red Hat Storage
Component: documentation
Version: 2
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 2
Assignee: Rakesh
QA Contact: Martin Kudlej
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-08-11 09:15 UTC by Martin Bukatovic
Modified: 2018-11-19 05:32 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-11-19 05:32:35 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1298096 0 unspecified CLOSED Red Hat Storage Console should be fully functional with firewall activated 2021-02-22 00:41:40 UTC

Internal Links: 1298096

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.


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