-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
salt: Add dedicated Ingress for MetalK8s docs #3299
Conversation
Hello gdemonet,My role is to assist you with the merge of this Status report is not available. |
Waiting for approvalThe following approvals are needed before I can proceed with the merge:
Peer approvals must include at least 1 approval from the following list:
|
Ideally, we would add some simple end-to-end tests checking that all exposed services continue working as desired when configuring the UI base path. We will need to postpone this task to a later improvement however, due to pressing matters. |
64bbce1
to
2feba68
Compare
Adding a `rewrite-target` annotation is needed when the base path is not /, because NGINX does not know where to find the documentation static files. We now always expose MetalK8s docs behind /docs, optionally appending the configured base path for MetalK8s UI (e.g. /docs/platform). This will avoid strange conflicts with the behaviour of the current Ingress when running MetalK8s at a non-root path, because mixing regular expressions and exact matches does not play well with ingress-nginx. See: #3254 See: https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#use-regex
2feba68
to
25ae467
Compare
/approve |
Waiting for approvalThe following approvals are needed before I can proceed with the merge:
Peer approvals must include at least 1 approval from the following list:
The following options are set: approve |
In the queueThe changeset has received all authorizations and has been added to the The changeset will be merged in:
The following branches will NOT be impacted:
There is no action required on your side. You will be notified here once IMPORTANT Please do not attempt to modify this pull request.
If you need this pull request to be removed from the queue, please contact a The following options are set: approve |
I have successfully merged the changeset of this pull request
The following branches have NOT changed:
Please check the status of the associated issue None. Goodbye gdemonet. |
Adding a
rewrite-target
annotation is needed when the base path is not/, because NGINX does not know where to find the documentation static
files.
We now always expose MetalK8s docs behind /docs, optionally appending
the configured base path for MetalK8s UI (e.g. /docs/platform).
This will avoid strange conflicts with the behaviour of the current
Ingress when running MetalK8s at a non-root path, because mixing regular
expressions and exact matches does not play well with ingress-nginx.
See: #3254
See: https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#use-regex