apache/apisix

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

Open

#7,342 建立於 2022年6月28日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Lua (16,597 star) (2,860 fork)batch import
docgood first issue

描述

Current State

The Integration service discovery registry 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

貢獻者指南

技術棧
無
領域
documentationbackenddevops
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
APISIX service discoveryEureka basicsDocumentation writing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
Review the existing integration service discovery documentation at https://apisix.apache.org/docs/apisix/discovery/. Examine the current Eureka example and the discussion with @bzp2010 in the issue comments. Determine how to restructure the docs to clearly show Eureka as built in and create a new example for implementing a custom provider.