apache/apisix

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

Open

Aperta il 28 giu 2022

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Lua (16.597 star) (2860 fork)batch import
docgood first issue

Descrizione

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

Guida contributor

Tech stack
Nessuno
Dominio
documentationbackenddevops
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
APISIX service discoveryEureka basicsDocumentation writing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45
Direzione di ricerca
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.