Bug 1843042
| Summary: | API documentation for image registry spec.logging field should describe what the logging attributes actually do | |||
|---|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Clayton Coleman <ccoleman> | |
| Component: | Image Registry | Assignee: | Ricardo Maraschini <rmarasch> | |
| Status: | CLOSED ERRATA | QA Contact: | Wenjing Zheng <wzheng> | |
| Severity: | high | Docs Contact: | ||
| Priority: | unspecified | |||
| Version: | 4.5 | CC: | aos-bugs, obulatov, pasik, rmarasch, xiuwang | |
| Target Milestone: | --- | |||
| Target Release: | 4.6.0 | |||
| Hardware: | Unspecified | |||
| OS: | Unspecified | |||
| Whiteboard: | ||||
| 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.
|
Story Points: | --- | |
| Clone Of: | ||||
| : | 1843244 (view as bug list) | Environment: | ||
| Last Closed: | 2020-10-27 16:04:06 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: | 1843244 | |||
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. This field is being deprecated on 4.6. There is not much we can do here other than wait until the changes land on https://bugzilla.redhat.com/show_bug.cgi?id=1808118. Still awaiting for https://bugzilla.redhat.com/show_bug.cgi?id=1808118 Still awaiting for https://bugzilla.redhat.com/show_bug.cgi?id=1808118 Still awaiting for https://bugzilla.redhat.com/show_bug.cgi?id=1808118 logLevel <string>
logLevel is an intent based logging for an overall component. It does not
give fine grained control, but it is a simple way to manage coarse grained
logging choices that operators have to interpret for their operands. Valid
values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
Verified on 4.6.0-0.nightly-2020-09-10-195619.
logging <integer>
logging is deprecated, use logLevel instead.
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.6 GA Images), 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:4196 |
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.