backstage/backstage

Incremental Ingestion Admin Interface

Open

#30 442 ouverte le 3 juil. 2025

Voir sur GitHub
 (4 commentaires) (2 réactions) (0 assignés)TypeScript (26 101 stars) (5 277 forks)batch import
area:cataloggood first issuepriority:contrib-neededtype:suggestion

Description

📜 Issue Labels

  • Please familiarize yourself with the issue labels used in this project: LABELS.md

🔎 Search Terms

Incremental, Ingestion, Admin Interface

🗃️ Project Area

Catalog

🔖 Need

The Incremental Ingestion Plugin has a great set of admin API endpoints, it would be really handy to have an interface for these to make it even easier to administer and get insight into the sate of things running under the Incremental Ingestion. Right now it's not easy to understand why something isn't working.

📝 Proposal

In the vein of the Unprocessed Entities plugin we could build a UI on top of these Admin API endpoints to be able to surface status, ingestions marks, and even trigger actions like start, stop, and cancel.

This could also use permissions to control access and what can be done.

finally, it could also be setup to be added as a tab to DevTools. This would be an optional feature though, it should run fine standalone.

🔄 Alternatives

The current method is to use the REST API and we could still do that.

Have you read the Code of Conduct?

Are you willing to submit a PR?

No, but I'm happy to collaborate on a PR with someone else

Guide contributeur

Stack technique
typescriptreactnodejs
Domaine
frontendbackenddeveloper experience
Type d'issue
feature
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.
3-5 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
TypeScriptReactBasic Backstage plugin structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
The issue proposes building an admin UI for the Incremental Ingestion plugin's existing REST API endpoints. To implement this, first examine the plugin's admin API routes at plugins/catalog backend module incremental ingestion/src/service/admin.ts and the Unprocessed Entities plugin (plugins/unprocessed entities) as a reference for UI structure. The UI should surface ingestion status, marks, and allow actions (start/stop/cancel). Consider integrating with Backstage's identity and permissions framework for access control. The comments may provide further guidance on scope and priorities.