docs: add explanation page for modes of operation#155
Conversation
erinecon
left a comment
There was a problem hiding this comment.
Thanks so much for adding this explanation document about the different modes of operation! I think this page will provide a lot of clarity for our users :D
| whether it propagates a proxied endpoint back to the backend — depends on the | ||
| **mode of operation**. | ||
|
|
||
| There are three modes, organised by the underlying route-provider interface and |
There was a problem hiding this comment.
| There are three modes, organised by the underlying route-provider interface and | |
| There are three modes, organized by the underlying route-provider interface and |
nit, US English
| ``` | ||
| haproxy <-- haproxy-route -- ingress-configurator | ||
| (config: backend-addresses, backend-ports) | ||
| ``` |
There was a problem hiding this comment.
I'm wondering whether this should be a Mermaid diagram -- I think the connections might be clearer (for example, it's not immediately obvious to me what is the difference between <-- and --).
Did you have any motivating factors for not using a Mermaid diagram here?
| ``` | ||
| haproxy <-- haproxy-route -- ingress-configurator <-- ingress -- backend-app | ||
| ``` |
There was a problem hiding this comment.
Same question about whether a Mermaid diagram should be used here
| ``` | ||
| gateway-api-integrator <-- gateway-route -- ingress-configurator <-- ingress -- backend-app | ||
| ``` |
There was a problem hiding this comment.
Same question about whether a Mermaid diagram should be used here
|
|
||
| In integrator mode, `ingress-configurator` is deployed without a direct | ||
| relation to the backend application. Instead, the operator provides the backend | ||
| address and port through charm configuration: |
There was a problem hiding this comment.
| address and port through charm configuration: | |
| address and port through charm configurations: |
Unless a single configuration sets the backend address and port, I think this should be plural
|
|
||
| This mode is suited to backends that are not managed by a Juju charm, or to | ||
| cases where the backend charm does not implement the `ingress` interface. | ||
| See {ref}`how_to_haproxy_integrate_non_charm_workload` for a worked example. |
There was a problem hiding this comment.
Nit: I think it might be a little misleading to say that the how-to guide shows a worked example since the guide has placeholders for e.g. the backend IP.
So I think we should rephrase this sentence, maybe something like:
| See {ref}`how_to_haproxy_integrate_non_charm_workload` for a worked example. | |
| See {ref}`how_to_haproxy_integrate_non_charm_workload` for instructions on | |
| using `ingress-configurator` in HAProxy integrator mode. |
I appreciate any other suggestions or thoughts here!
| `ingress` interface alone. See {ref}`how_to_add_haproxy_features_to_ingress_requirer` | ||
| for a worked example. |
There was a problem hiding this comment.
Same nit about being a bit misleading with "worked example". Maybe we can update to:
| `ingress` interface alone. See {ref}`how_to_add_haproxy_features_to_ingress_requirer` | |
| for a worked example. | |
| `ingress` interface alone. See {ref}`how_to_add_haproxy_features_to_ingress_requirer` | |
| for instructions on using `ingress-configurator` in HAProxy adapter mode. |
|
|
||
| See {ref}`how_to_gateway_api_integrate_non_charm_workload` for a worked example | ||
| using a non-charmed backend, and | ||
| {ref}`how_to_gateway_api_add_features_to_ingress_requirer` for a charmed backend. |
There was a problem hiding this comment.
| {ref}`how_to_gateway_api_add_features_to_ingress_requirer` for a charmed backend. | |
| {ref}`how_to_add_gateway_api_features_to_ingress_requirer` for a charmed backend. |
Okay this is the issue with the RTD build (not the other label, that one is fine)
| match the backend's pods. | ||
| ``` | ||
|
|
||
| See {ref}`how_to_gateway_api_integrate_non_charm_workload` for a worked example |
There was a problem hiding this comment.
| See {ref}`how_to_gateway_api_integrate_non_charm_workload` for a worked example | |
| See {ref}`how_to_gateway_api_integrate_non_charm_workload` for instructions |
Nit, to remove "worked example" which I feel is a bit misleading
Applicable spec:
Overview
Rationale
Juju Events Changes
Module Changes
Library Changes
Checklist
urgent,trivial,senior-review-required,documentation)docs/changelog.mdis updated with user-relevant changes.