Bug 2002034

Summary: guest image is missing man pages
Product: Red Hat Enterprise Linux 9 Reporter: Ondřej Budai <obudai>
Component: osbuild-composerAssignee: Ondřej Budai <obudai>
Status: CLOSED CURRENTRELEASE QA Contact: Wei Shi <wshi>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 9.0CC: lmiksik, pvlasin, wshi, xiliang
Target Milestone: rcKeywords: Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: osbuild-composer-33.1-1.el9_b Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 2002033
: 2004401 (view as bug list) Environment:
Last Closed: 2021-12-07 21:30: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:    
Bug Blocks: 2004401    

Description Ondřej Budai 2021-09-07 18:41:34 UTC
RHEL guest images built for 9.0 are missing man pages. /usr/bin/man is installed but /usr/share/man doesn't contain any useful content.

This can be reproduced by booting rhel-guest-image-9.0-20210906.6.x86_64.qcow2 and running e.g. man man:

$ man man
No manual entry for man
---

This bug was caused by accidentally installing all rpms with --excludedocs option that blocks installation of all man pages.

We're currently working on a fix upstream that should be hopefully trivial.

Correct behavior can be observed on e.g. rhel-guest-image-9.0-20210809.6.x86_64.qcow2 man man on this image successfully show the man page for man itself.

Comment 3 Ondřej Budai 2021-09-08 18:17:41 UTC
> ======= Impact Statement ======= 
> 
> What is the benefit of making this change after the deadline? What is the
> impact on customer satisfaction, and on the business?
> 

If we don't ship this bugfix, guest images for RHEL 9.0 Beta will be shipped without man pages. This is a regression from RHEL 8, and thus it would lead to many confused customers that would want to develop on systems based on the guest image (e.g. in RHOS) but the latest version of it would not ship the embedded documentation important for many system administrators.

> 
> What is the risk to the release schedule, quality, and the impact of
> diverting resources from other efforts? Will there be enough time to do the
> necessary large-scale, cross-function, regression, stress, or
> fault-insertion testing that may be required to verify this change?

This bug is caused by always passing --excludedocs to rpm(1) when installing packages during the image creation. The bugfix is simple: The flag will be removed. As this change is fairly isolated and building images including rpm docs worked for many months before this bug was introduced, we don't foresee any issues caused by shipping this bugfix. The upstream PR is in preparation and so far, we didn't encounter any issues.

> 
> ============================= 
> 
> In addition to the impact statement above, check the BZ to confirm the
> following: 
> 
> 1. The Internal Target Release (ITR) field reflects the correct release.
> 2. Set the Internal Target Milestone (ITM) field to indicate by when the
> work will be done. The approval for this exception will expire on that
> milestone. 
> 3. Ensure qa_ack+ and devel_ack+ are set, and that those acks are not
> leftover from before the exception request.
> 4. Prepare a RHEL rpm scratch build and have this change validated on the
> latest RHEL milestone compose by someone other than the developer. A comment
> must be added to the Bugzilla indicating the validation is successful and
> there were no observed regressions.
> 
> All of these steps must be complete before this change is reviewed as an
> exception.

Comment 4 Ondřej Budai 2021-09-09 12:26:36 UTC
The PR fixing this regression is ready upstream.

Comment 6 Ondřej Budai 2021-09-17 10:01:57 UTC
I built an image using the new osbuild-composer build, booted it and ran `man man` and the man page did open. Thus, I'm setting this as pre-verified.