apache/apisix

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

Open

#7 342 ouverte le 28 juin 2022

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Lua (16 597 stars) (2 860 forks)batch import
docgood first issue

Description

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

Guide contributeur

Stack technique
Aucun
Domaine
documentationbackenddevops
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
APISIX service discoveryEureka basicsDocumentation writing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45
Direction de recherche
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.