Skip to content
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

Add documentation detailing all possible ingress routes on app #4474

Open
WhitWaldo opened this issue Dec 19, 2024 · 1 comment
Open

Add documentation detailing all possible ingress routes on app #4474

WhitWaldo opened this issue Dec 19, 2024 · 1 comment
Labels
content/missing-information More information requested or needed

Comments

@WhitWaldo
Copy link
Contributor

What content needs to be created or modified?
There are a great many routes that are automatically created by the various SDKs into an application. It'd be nice to get a document that details each of them so that network operators can more easily set up blacklists on load balancing filters so external traffic doesn't readily hit Dapr-created endpoints.

Describe the solution you'd like
Create documentation with a list of each of the route patterns for each building block.

Where should the new material be placed?
I wouldn't think that most of this is SDK specific, but it might bear some research on that front. If it's not SDK-specific, probably somewhere under https://docs.dapr.io/reference/ would be a good place. Otherwise, if any of the routes depend on the SDK, common endpoints should be located in the reference doc with references to the SDK-specific routes to their own respective documentation endpoints.

The associated pull request from dapr/dapr, dapr/components-contrib, or other Dapr code repos
New content request - haven't written/researched it yet

Additional context
Happy to take this on myself, but don't know if I can commit to a 1.15 release or not. It could be released anytime after 1.15 as I'll include those routes as well.

@WhitWaldo WhitWaldo added the content/missing-information More information requested or needed label Dec 19, 2024
@juselius
Copy link

This would be very useful indeed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content/missing-information More information requested or needed
Projects
None yet
Development

No branches or pull requests

2 participants