radius-project / radius-project/docs
Gateways tutorial needs to tell you how to find the address
Nobody has claimed this yet.
- Dominant language
- Bicep
- Stars
- 26
- Forks
- 52
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 3
Description
What content needs to be created or modified?
https://docs.radapp.io/guides/author-apps/networking/gateways/
There's an incredible variation of different cases for gateways and addresses across different distros of Kubernetes.
The most common case for users doing a tutorial is using a local installation of Kubernetes (not a cloud hosted distro). In this case Radius is going to report the gateway URL as "unknown".
The tutorial doesn't address this at all.
Describe the solution you'd like
The how-to needs to explain the cases where unknown can be returned by Radius, and how to find the right address.
Where should the new material be placed?
As part of this page, or in an FAQ about gateways/networking and linked form this page.
Additional context
Originally reported via Discord here: https://discord.com/channels/1113519723347456110/1167683397909479474
For a locally installation of Kubernetes, the user is working through multiple levels of virtualization:
Host -> VM -> Nodes (VMs or Containers) -> Containers
At each of these layers the networking environment and IPs that can be routed are different.
We need to know the IP address that can be used by the Host to talk to one of the Nodes. Kubernetes is running on the Nodes and has no way to reason about the outer layers of configuration.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the gateways tutorial at https://docs.radapp.io/guides/author-apps/networking/gateways/ and identify where it presents the gateway URL. Research how Radius reports unknown for locally installed Kubernetes and how users can find an address reachable from the host across common local setups. Done means the tutorial or a linked FAQ explains these cases and gives users a clear way to determine the correct address.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100