SS-1141 Added info on how to setup the custom backend for the errors on k8s level #62
Conversation
…evel Changed ingress configuration for the apps, so that they would redirect to our 503 page in case app not working Up apps charts versions
|
Thanks for the ping, I'll have a look soon. |
There was a problem hiding this comment.
The annotations looks in order, as far as I can tell. But I would suggest you review the documented way-of-working for deploying this. As you see in my comments, I think much of this deserves to be files in the repo which are applied via kubectl. That will make it much easier for you to version control any future code changes and also makes the deployment process less error prone.
Do you have Argo CD for deploying manifests? If so, I would probably suggest configuring that instead of applying this manually.
README.md
Outdated
| <details> | ||
| <summary>Click to see the content of the custom-error-backend.yaml file</summary> | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
I think the indentation is incorrect for this code fencing. Does not look right when looking at the rendered README.
README.md
Outdated
|
|
||
| Configuration for the default backend: service and handling of a 404 error on a subdomain level (wild card domain). | ||
|
|
||
| Create `custom-error-backent.yaml` file with the following content. |
There was a problem hiding this comment.
- Typo:
-backent - Totally up to you, but personally I would prefer to have
custom-error-backend.yamlas a file, not just in the README. It's so long (and important), it deserves to be a file I think.
README.md
Outdated
| $ kubectl apply -f custom-error-backend.yaml | ||
| ``` | ||
|
|
||
| In the rancher dashboard change the values for configmaps `custom-error-pages-404` and `custom-error-pages-503` to |
There was a problem hiding this comment.
I would advice against using Rancher's dashboard features to edit ConfigMaps. Not that it would not work, just that it's very easy to make mistakes. Instead, I suggest you create the ConfigMaps using kubectl.
There was a problem hiding this comment.
I was trying my best to set it up via config map, but it kept giving me errors like this for:: invalid JSON document or unicode errors.
Rancher's forms were able to handle this, so I went with them
There was a problem hiding this comment.
Should be possible to do like this:
kubectl create configmap custom-error-pages --from-file 404=./html/404.html --from-file 503=./html/503.htmlThe result should look similar to this: https://github.com/kubernetes/ingress-nginx/blob/6ceccbd67b140b7626670ad17f926f121a9e5563/docs/examples/customization/custom-errors/custom-default-backend-error_pages.configMap.yaml
There was a problem hiding this comment.
There were apparently a misconfiguration in Rancher causing this to break. It's fixed now.
README.md
Outdated
| Take `404.html` file from [here](error-page-404.html) | ||
|
|
||
| Take `503.html` file from [here](error-page-503.html) |
There was a problem hiding this comment.
| Take `404.html` file from [here](error-page-404.html) | |
| Take `503.html` file from [here](error-page-503.html) | |
| You find the error pages in [error-page-404.html](error-page-404.html) and [error-page-503.html](error-page-503.html). |
| @@ -10,6 +10,8 @@ metadata: | |||
| nginx.ingress.kubernetes.io/auth-url: "{{ .Values.global.protocol }}://{{ .Values.global.auth_domain }}:8080/auth/?release={{ .Values.release }}" | |||
| nginx.ingress.kubernetes.io/auth-signin: "https://{{ .Values.global.domain }}/accounts/login/?next=$scheme%3A%2F%2F$host" | |||
| {{- end }} | |||
| nginx.ingress.kubernetes.io/custom-http-errors: "503" | |||
There was a problem hiding this comment.
In the README, you give instructions for configuring both 404 and 503, yet here you only configure 503. Is that intentional?
Removed info on custom default backend from the README.md file Added 503 handling for the studio pod
|
Follow up pr ScilifelabDataCentre/serve#260 |
For now you can try out 404 page like this:
https://rstarst.serve-dev.scilifelab.se/