Bug 2081119

Summary: `oc explain` output of default overlaySize is outdated
Product: OpenShift Container Platform Reporter: Qi Wang <qiwan>
Component: NodeAssignee: Qi Wang <qiwan>
Node sub component: Kubelet QA Contact: MinLi <minmli>
Status: CLOSED ERRATA Docs Contact:
Severity: low    
Priority: low CC: aos-bugs, minmli
Version: 4.11   
Target Milestone: ---   
Target Release: 4.11.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-08-10 11:09:59 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: 2081452    

Description Qi Wang 2022-05-02 20:00:05 UTC
Description of problem:

`oc explain` output of default overlaySize is 10G. The outdated doc confused the customer with default overlaySize. The description should be updated since the default was removed from the implementation of storage.conf.

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


How reproducible:


Actual results:

$ oc explain containerRuntimeConfig.spec.containerRuntimeConfig.logLevel
KIND:     ContainerRuntimeConfig
VERSION:  machineconfiguration.openshift.io/v1

FIELD:    logLevel <string>

DESCRIPTION:
     logLevel specifies the verbosity of the logs based on the level it is set
     to. Options are fatal, panic, error, warn, info, and debug.
[qiwan@qiwan ~]$ oc explain containerRuntimeConfig.spec.containerRuntimeConfig.overlaySize
KIND:     ContainerRuntimeConfig
VERSION:  machineconfiguration.openshift.io/v1

FIELD:    overlaySize <string>

DESCRIPTION:
     overlaySize specifies the maximum size of a container image. This flag can
     be used to set quota on the size of container images. (default: 10GB).


Expected results:

$ oc explain containerRuntimeConfig.spec.containerRuntimeConfig.logLevel
KIND:     ContainerRuntimeConfig
VERSION:  machineconfiguration.openshift.io/v1

FIELD:    logLevel <string>

DESCRIPTION:
     logLevel specifies the verbosity of the logs based on the level it is set
     to. Options are fatal, panic, error, warn, info, and debug.
[qiwan@qiwan ~]$ oc explain containerRuntimeConfig.spec.containerRuntimeConfig.overlaySize
KIND:     ContainerRuntimeConfig
VERSION:  machineconfiguration.openshift.io/v1

FIELD:    overlaySize <string>

DESCRIPTION:
     overlaySize specifies the maximum size of a container image. This flag can
     be used to set quota on the size of container images.



Additional info:

Comment 4 MinLi 2022-05-11 06:52:13 UTC
verified.

% oc get clusterversion 
NAME      VERSION                              AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.11.0-0.nightly-2022-05-10-045003   True        False         16m     Cluster version is 4.11.0-0.nightly-2022-05-10-045003

% oc explain containerRuntimeConfig.spec.containerRuntimeConfig.overlaySize
KIND:     ContainerRuntimeConfig
VERSION:  machineconfiguration.openshift.io/v1

FIELD:    overlaySize <string>

DESCRIPTION:
     overlaySize specifies the maximum size of a container image. This flag can
     be used to set quota on the size of container images.

Comment 6 errata-xmlrpc 2022-08-10 11:09:59 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 (Important: OpenShift Container Platform 4.11.0 bug fix and security 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/RHSA-2022:5069