Bug 1843244 - [4.5] API documentation for image registry spec.logging field should describe what the logging attributes actually do
Summary: [4.5] API documentation for image registry spec.logging field should describe...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Image Registry
Version: 4.5
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: 4.5.z
Assignee: Ricardo Maraschini
QA Contact: Wenjing Zheng
URL:
Whiteboard:
Depends On: 1843042
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-06-02 20:59 UTC by Oleg Bulatov
Modified: 2020-10-12 15:48 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Feature: Document meaning for "logging" field. Reason: It was not documented what each logging level (defined as an integer) mean for the operand. Result: Now users can check the documentation to see what each value for this field mean.
Clone Of: 1843042
Environment:
Last Closed: 2020-10-12 15:47:56 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift api pull 733 0 None closed [release-4.5] Bug 1843244: Adding documentation for Logging field 2020-09-27 08:42:20 UTC
Github openshift cluster-image-registry-operator pull 614 0 None closed Bug 1843244: Add documentation for Logging field 2020-09-27 08:42:20 UTC
Red Hat Product Errata RHBA-2020:3843 0 None None None 2020-10-12 15:48:20 UTC

Description Oleg Bulatov 2020-06-02 20:59:12 UTC
+++ This bug was initially created as a clone of Bug #1843042 +++

oc explain configs.spec --api-version=imageregistry.operator.openshift.io/v1


   logging	<integer> -required-
     logging determines the level of logging enabled in the registry.


Should actually tell me what 0, 1, 2, 3, 4 mean.  Otherwise I can't (in console or CLI) actually determine what to set.  We should describe the int, the level, and what output it includes.

This is an important field, this is a common debug operation, so setting to high.

--- Additional comment from Oleg Bulatov on 2020-06-02 22:57:56 CEST ---

Note, in 4.6 it's going to be deprecated by logLevel, but it's important to update docs in older releases.

Note 2: CRD comes via the image registry operator, so docs needs to be updated, and the update needs to be vendored to cluster-image-registry-operator.

Comment 1 Ricardo Maraschini 2020-06-17 12:49:45 UTC
Not much to be done here until we get https://bugzilla.redhat.com/show_bug.cgi?id=1843042 merged and verified.

Comment 2 Oleg Bulatov 2020-07-09 21:47:44 UTC
Depends on the bug 1843042.

Comment 3 Oleg Bulatov 2020-07-31 13:58:20 UTC
Depends on the bug 1843042.

Comment 4 Ricardo Maraschini 2020-08-21 12:29:31 UTC
Depends on the bug 1843042.

Comment 5 Oleg Bulatov 2020-09-11 21:29:48 UTC
Waiting for cherry-pick-approved

Comment 7 Wenjing Zheng 2020-09-21 09:37:22 UTC
Waiting for a newer payload to verify:
$ ./oc version
Client Version: 4.5.0-0.nightly-2020-09-20-185910
Server Version: 4.5.0-0.nightly-2020-09-18-174934
Kubernetes Version: v1.18.3+b0068a8

Comment 9 Wenjing Zheng 2020-09-22 09:03:43 UTC
$ ./oc version
Client Version: 4.5.0-0.nightly-2020-09-20-185910
Server Version: 4.5.0-0.nightly-2020-09-20-185910
Kubernetes Version: v1.18.3+47c0e71

I still can see below display:
   logging	<integer> -required-
     logging determines the level of logging enabled in the registry.

Maybe I verify this bug https://bugzilla.redhat.com/show_bug.cgi?id=1843042#c10 with incorrect steps? since for spec.loglevel, it has description about log level, but also has no such info for spec.logging(it is marked as deprecated now)

Comment 10 Ricardo Maraschini 2020-09-22 09:21:34 UTC
Regarding https://bugzilla.redhat.com/show_bug.cgi?id=1843042#c10, I think you have validated it correctly

1. The field "logging" has been deprecated so the message is correct
2. Please check you can see documentation for the field "logLevel", this field is used instead of "logging" from 4.6 onwards


As for this one it seems like we missed the bump on the project, I will get it fixed.

Comment 13 Wenjing Zheng 2020-09-27 09:00:44 UTC
Verified on 4.5.0-0.nightly-2020-09-26-194704:
   logging	<integer> -required-
     logging determines the level of logging enabled in the image registry.
     Valid values are: 0) log only error messages, 1) log error and warning
     messages, 2) or 3) log error, warning and information messages, 4) enables
     debug log.

Comment 16 errata-xmlrpc 2020-10-12 15:47:56 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 (OpenShift Container Platform 4.5.14 bug fix 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-2020:3843


Note You need to log in before you can comment on or make changes to this bug.