Explain how to try API gateway on a local machine using local.kyma.dev domain

[mluk-sap]

Description

There are some inconsistencies in API Gateway tutorial
Let's look at it from a developer perspective that just wants to play with it in local computer, without external resources like Gardener.

1. In general - it is not very clear what does 'Kyma domain' mean. This term appears in 'Set Up a Custom Domain' and is opposed to 'Custom domain' (which is also 'for kyma' in this context). It would be nice to explain what is it and how to use it (whether user gets it OOTB when they use Gardener, or managed Kyma, etc.)
2. In particular, the end-user at that point has no idea that there is a wildcard domain *.local.kyma.dev (registered in public DNS) pointing to the local host (127.0.0.1), which is ideal for the local development. So there is no need to have own custom domain, etc.
3. There is no example that shows how to create a gateway without TLS, which is useful for local development.
4. In 'Expose a workload' section the Gateway existence is not listed in prerequisites, which suggests that it is optional.
5. In 'Expose a workload' section there is an information about adding 'httpbin.kyma.local' to /etc/hosts, which is not required when using *.local.kyma.dev. I think we can just remove it.

Maybe we should consider adding an additional tab, like 'Local domain' (next to 'Custom Domain' and 'Kyma Domain')

Reasons

It is hard to understand how to try it out on a local machine.

Attachments