Commit c71ce8f
committed
Revert "OCPBUGS#9448: Add a note regarding checking clusterversion"
This reverts commit fb0d246, #57136.
The commit message did not explain the motivation, but [1] has:
One note is:
"
After the update completes, you can confirm that the cluster version has updated to the new version:
$ oc get clusterversion
"
The thing is that if the upgrade didn't complete, this output may include errors, for example:
" oc get clusterversion
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS
version 4.10.26 True True 24m Unable to apply 4.11.0-rc.7: an unknown error has occurred: MultipleErrors
"
We should include a note to disregard these errors as long as the "Progressing" is in True.
But 1143cbe (Removed jq commands and replaced with oc adm upgrade,
2023-01-20, #55005) was moving us from 'oc get clusterversion' towards
'oc adm upgrade' for "show my current context". Both get
ClusterVersion and print a summary of its current status to the
console. 'oc get ...' is generic CustomResourceDefinition rendering
and the only knobs are things like additionalPrinterColumns, because
'get' needs to work if there are multiple matching resources and fit
them each into one line of text. We have more control over the
rendering in 'oc adm upgrade', where we know we only care about the
ClusterVersion named 'cluster', and can take as many lines as we need
to explain the details of the current cluster state. So basically
there's no upside to using 'oc get clusterversion', unless you are
using '-o json' or something and piping the results into a robot for
structured consumption. For direct human consumption, 'oc adm
upgrade' will always be better, and in this commit, I'm moving us back
to using 'oc adm upgrade'. This also gets the intervening 'Cluster
version is <version>' example output back to making sense, since
fb0d246 failed to update that example output when it pivoted
the suggested command.
I'm also dropping the "you can ignore the error" line. While there
are certainly cases when cluster components ask for admin intervention
(e.g. by setting Available=False in a ClusterOperator) despite admin
intervention not actually being needed, it is absolutely not a good
idea to ignore those in general. Cases:
* Cluster claims it is happy...
* ... and it actually is happy. Hooray!
* ... but it is actually unhealthy. Worth a bug to the overly
optimistic component about more accurately reporting that it is
unhealthy, and should be calling for admin intervention.
* Cluster claims it is unhealthy...
* ... and it actually is unhealthy. Sad. But at least it is
appropriately calling for help. Error messages should be
actionable, so the admin can quickly identify and resolve the
issue, and if not, it is worth a bug to the opaquely-failing
component about more helpfully guiding the admin through
triage and resolution.
* ... but it is actually pretty healthy. This is the case where the
admin could ignore the error message. But it is hard to
distinguish from the "actually unhealthy" cases where the admin
should not ignore the error message. Certainly:
an unknown error has occurred: MultipleErrors
is insufficient data to decide that the error report is
false-positive noise. Worth digging into the source of the error
report, and a bug to the noisy component about not calling for
admin assistance when no intervention is actually needed.
There will probably always be some corner cases where the cluster does
not ask for help despite needing help, or the cluster asks for help
despite not needing help, but as the controllers get smarter, those
cases should become more and more rare, to the point where we should
not need to discuss them in docs beyond generic comments pointing out
that no real-world diagnostic system is completely free of
false-positive and false-negative risk.
[1]: https://issues.redhat.com/browse/OCPBUGS-94481 parent 93b2563 commit c71ce8f
1 file changed
+0
-9
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
132 | | - | |
133 | | - | |
134 | | - | |
135 | | - | |
136 | | - | |
137 | | - | |
138 | | - | |
139 | | - | |
140 | | - | |
141 | 132 | | |
142 | 133 | | |
143 | 134 | | |
| |||
0 commit comments