Bug 2003961
| Summary: | Instructions for httpErrorCodePages feature in Ingress Controller unclear, can cause cluster outage | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Xander Soldaat <xsoldaat> |
| Component: | Documentation | Assignee: | Vikram Goyal <vigoyal> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | jechen <jechen> |
| Severity: | urgent | Docs Contact: | Vikram Goyal <vigoyal> |
| Priority: | high | ||
| Version: | 4.9 | CC: | aos-bugs, hongli, jechen, jokerman, misalunk, sarthoma, trees |
| Target Milestone: | --- | Keywords: | Reopened |
| Target Release: | --- | ||
| 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: | 2021-10-14 17:23: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: | |||
|
Description
Xander Soldaat
2021-09-14 08:41:10 UTC
>> The root of the problem lies in the name of the key "httpErrorCodePages". This should have been named "httpErrorCodeResponses", as simply passing an HTML file causes catastrophic failure. The HAProxy expects a pre-cooked HTTP response, including a properly formatted HTTP header, and any and all HTML code that must be sent to the connecting client. The documentation should reflect this, with explicit instructions on how to create these files, using simple examples. 1. I appreciate your feedback on the name of the field but we are setting the errorfile directive which specifies an HTTP response status code and the path to an HTML page. That is why we think Pages in httpErrorCodePages is fine https://www.haproxy.com/documentation/hapee/latest/configuration/config-sections/http-errors/ 2. The documentation work is still in progress. I have shared my review on this PR https://github.com/openshift/openshift-docs/pull/36065 related to this feature. @sarthoma can please look into this a your earliest ? I have no problems if the name is picked to remain consistent with the albeit badly chosen term in HAProxy. Some examples, such as in the HAProxy documentation would go a long way to explain what it is expecting. I do like the additional explanation of the mechanism of how the data is integrated with the Ingress Controller, in the PR. @sarthoma - is this the latest preview of the docs? https://deploy-preview-36065--osdocs.netlify.app/openshift-enterprise/latest/networking/ingress-operator?utm_source=github&utm_campaign=bot_dp#nw-customize-ingress-error-pages_configuring-ingress I am checking before I report more issues, for instance the first command; "oc -n openshift-config create config map my-custom-error-code-pages" should have configmap as one word. In addition, we should end each line after it with '\' as its a continuation of the command. @ti @xsoldaa I added an IMPORTANT notice to step 1 in the config, so hopefully customers will notice here before calling in support: https://docs.openshift.com/container-platform/4.9/networking/ingress-operator.html#nw-customize-ingress-error-pages_configuring-ingress Xander ACK'd this change in a Slack message, so I'm marking CLOSED at CURRENT RELEASE. |