apache/apisix

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

Open

#7,342 opened on 2022年6月28日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Lua (16,597 stars) (2,860 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.