Bug 1866544

Summary:	Documentation error in rhel-system-roles postfix readme file
Product:	Red Hat Enterprise Linux 8	Reporter:	Husam Ahmed Chaudhary <huchaudh>
Component:	rhel-system-roles	Assignee:	Sergei Petrosian <spetrosi>
Status:	CLOSED ERRATA	QA Contact:	David Jež <djez>
Severity:	unspecified	Docs Contact:	Eliane Ramos Pereira <elpereir>
Priority:	unspecified
Version:	8.2	CC:	djez, elpereir, rmeggins
Target Milestone:	rc	Keywords:	Triaged
Target Release:	8.5	Flags:	pm-rhel: mirror+
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	role:postfix
Fixed In Version:	rhel-system-roles-1.2.0-1.el8	Doc Type:	Bug Fix
Doc Text:	.`relayhost` parameter no longer incorrectly defined in the Postfix documentation Previously, the `relayhost` parameter of the Postfix RHEL System Role was defined as `relay_host` in the `doc /usr/share/doc/rhel-system-roles/postfix/README.md` documentation provided by `rhel-system-roles`. This update fixes the issue and the `relayhost` parameter is now correctly defined in the `Postfix` documentation.	Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-11-09 17:44:38 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:	1957876
Bug Blocks:	1866053

Description Husam Ahmed Chaudhary 2020-08-05 20:41:47 UTC

Description of problem:

The relayhost parameter of postfix is defined as relay_host in the doc /usr/share/doc/rhel-system-roles/postfix/README.md.

~~~~~~~~~
Sample from the doc

Install and enable postfix. Do single backup of main.cf (older backup will be
rewritten) and configure "relay_host=example.com":

```yaml
---
- hosts: all
  vars:
    postfix_conf:
      relay_host: "example.com" <<<-------------
    postfix_backup: true
  roles:
    - linux-system-roles.postfix
```

~~~~~~~~~~

Version-Release number of selected component (if applicable):

rhel-system-roles-1.0-10.el8_1.noarch


Expected results:

The parameter should be relayhost and not relay_host.


Additional info:

The doc is provided by rhel-system-roles

# rpm -qf /usr/share/doc/rhel-system-roles/postfix/README.md
rhel-system-roles-1.0-10.el8_1.noarch

Comment 2 Pavel Cahyna 2021-03-17 10:11:43 UTC

Thank you for the report, the change did not make it into 8.4, but we are considering it for a future release.

Comment 3 Rich Megginson 2021-04-01 22:55:38 UTC

merged upstream

Comment 19 errata-xmlrpc 2021-11-09 17:44:38 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/RHBA-2021:4159