Bug 2094096

Summary: Update Ansible syntax in Firewall system role README.md file examples
Product: Red Hat Enterprise Linux 9 Reporter: Rich Megginson <rmeggins>
Component: rhel-system-rolesAssignee: Rich Megginson <rmeggins>
Status: CLOSED ERRATA QA Contact: Jakub Haruda <jharuda>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 9.1CC: briasmit, jharuda, nhosoi, rhel-cs-system-management-subsystem-qe, rmeggins, spetrosi, vpunj
Target Milestone: rc   
Target Release: 9.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: role:firewall
Fixed In Version: rhel-system-roles-1.19.2-1.el9 Doc Type: No Doc Update
Doc Text:
Story Points: ---
Clone Of: 2081839 Environment:
Last Closed: 2022-11-15 10:23:47 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: 2081839    
Bug Blocks:    

Description Rich Megginson 2022-06-06 20:13:59 UTC 
+++ This bug was initially created as a clone of Bug #2081839 +++

Description of problem:
The firewall system role README.md file has several examples with syntax similar to this:

service: [ 'tftp', 'ftp' ]

From what I understand this syntax is deprecated and the recommended syntax is:

service: [tftp, ftp]

Version-Release number of selected component (if applicable):  RHEL 8.6 / 9.0


How reproducible:
Every time

Steps to Reproduce:
1. cat /usr/share/doc/rhel-system-roles/firewall/README.md

--- Additional comment from Rich Megginson on 2022-05-04 20:14:50 UTC ---

(In reply to Brian Smith from comment #0)
> Description of problem:
> The firewall system role README.md file has several examples with syntax
> similar to this:
> 
> service: [ 'tftp', 'ftp' ]
> port: [ '443/tcp', '443/udp' ]
> 
> From what I understand this syntax is deprecated and the recommended syntax
> is:
> 
> service: '[tftp, ftp]'
> port: '[443/tcp, 443/udp]'
> 
> Version-Release number of selected component (if applicable):  RHEL 8.6 / 9.0
> 
> 
> How reproducible:
> Every time
> 
> Steps to Reproduce:
> 1. cat /usr/share/doc/rhel-system-roles/firewall/README.md

To clarify:

service: [tftp, ftp]

Is preferred for very short lists as opposed to

service:
  - tftp
  - ftp

which is also correct but much more verbose.

note that '[tftp, ftp]' is a string, not a list

Also note that [tftp, ftp] is preferred over ['tftp', 'ftp'] since in YAML tftp and ftp are unambiguously string values.

However, port: ['443/tcp', '443/udp']

the values should be quoted as they begin with a number - quoting the values explicitly makes them strings so there is no ambiguity.

--- Additional comment from Brian Smith on 2022-05-06 16:01:12 UTC ---

Updated description.

--- Additional comment from Vrinda on 2022-05-24 17:45:15 UTC ---

https://github.com/linux-system-roles/firewall/pull/75
Comment 10 errata-xmlrpc 2022-11-15 10:23:47 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (rhel-system-roles bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2022:8117