apache / apache/apisix

docs: Rework the service discovery documentation in general and Eureka in particular

Open
#7,342 2 comments 0 reactions 0 assignees View on GitHub
doc good first issue
Dominant language
Lua
Stars
17.1k
Forks
2.9k
Avg merge
3d 16h
Merged PRs (30d)
63

Description

### Current State

The [Integration service discovery registry](https://apisix.apache.org/docs/apisix/discovery/) mentions service discovery and how you can potentially create your own mechanism. It uses the example for Eureka.

After discussing with @bzp2010, it seems there's no need to create Eureka as it's part of the out-of-the-box features.

### Desired State

We shall:

- Document how to use Eureka as a service discovery provider
- Design a new example on how to implement one custom service discovery provider

Contributor guide

Open the contributing guide

Research direction

Start with the linked service discovery documentation at https://apisix.apache.org/docs/apisix/discovery/ and compare its current Eureka example with the desired state. Done means the documentation explains how to use Eureka and includes a new example showing how to implement a custom service discovery provider.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.