Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 2081839

Summary: Update Ansible syntax in Firewall system role README.md file examples
Product: Red Hat Enterprise Linux 8 Reporter: Brian Smith <briasmit>
Component: rhel-system-rolesAssignee: Rich Megginson <rmeggins>
Status: CLOSED ERRATA QA Contact: David Jež <djez>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.6CC: djez, nhosoi, rmeggins, spetrosi
Target Milestone: rcFlags: vpunj: needinfo+
pm-rhel: mirror+
Target Release: 8.7   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: role:firewall
Fixed In Version: rhel-system-roles-1.19.1-1.el8 Doc Type: No Doc Update
Doc Text:
Story Points: ---
Clone Of:
: 2094096 (view as bug list) Environment:
Last Closed: 2022-11-08 09:41:24 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: 2094096    

Description Brian Smith 2022-05-04 19:22:50 UTC
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

Comment 1 Rich Megginson 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.

Comment 2 Brian Smith 2022-05-06 16:01:12 UTC
Updated description.

Comment 15 errata-xmlrpc 2022-11-08 09:41:24 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:7568